home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / dsply13.zip / DISPLAY.DOC < prev    next >
Text File  |  1991-10-10  |  9KB  |  240 lines
  1. DISPLAY.EXE version 1.3 <c> 1991 by Carl Sagerquist   Data (805) 723-6908
  2.  
  3. DESCRIPTION
  4. -----------
  5.  
  6.     DISPLAY.EXE is a BBS news letter display program.  DISPLAY will
  7.     begin by reading the file created by the BBS (DOOR.SYS,
  8.     DORINFO1.DEF, etc.).  This file will contain the caller's name,
  9.     color switch, the BBS com port, etc. as needed by DISPLAY.  Not
  10.     all BBS's are supported yet, others will be added as data becomes
  11.     available.  DISPLAY will ask the caller if he/she would like to
  12.     view the newsletter.  If so, the news file is sent, 23 lines at
  13.     a time.  Each pause, the caller has the option to continue or
  14.     stop.
  15.  
  16. SYNTAX
  17. ------
  18.  
  19.     DISPLAY [-bbstype] [ASCII filename] [ANSI filename]
  20.  
  21. EXAMPLE
  22. -------
  23.  
  24.     DISPLAY -MAXIHOST NEWSLETR.ASC NEWSLETR.ANS
  25.  
  26. SUPPORTED BBS'S
  27. ---------------
  28.  
  29.         Generic:       -DOORSYS       (DOOR.SYS)
  30.         Local Mode:    -LOCAL         (        )
  31.         Maxihost:      -MAXIHOST      (DOOR.SYS)
  32.         Megahost:      -MEGAHOST      (DOOR.SYS)
  33.     PCBoard:       -PCBOARD       (DOOR.SYS)
  34.         QuickBBS:      -QBBS          (DORINFO1.DEF)
  35.         RBBS:          -RBBS          (DORINFO1.DEF)
  36.         Wildcat:       -WILDCAT       (CALLINFO.BBS)
  37.  
  38. FILES IN THIS ZIP PAXKAGE
  39. -------------------------
  40.  
  41.     DISPLAY  EXE  --  Executable Program.
  42.     TEST     BAT  --  Batch file for testing.
  43.     DISPLAY  DOC  --  Document file: This file.
  44.     DISPLAYQ ASC  --  Custom ASCII start question file.
  45.     DISPLAYQ ANS  --  Custom ANSI  start question file.
  46.     NEWS     ASC  --  Sample ASCII news file.
  47.     NEWS     ANS  --  Sample ANSI  news file.
  48.     CALLINFO BBS  --  Sample BBS file.
  49.     DORINFO1 DEF  --  Sample BBS file.
  50.     DOOR     SYS  --  Sample BBS file.
  51.  
  52. REGISTRATION
  53. ------------
  54.  
  55.     This program is not free, but Shareware.  You may evaluate this
  56.     program for a period of 30 days.  If you decide to continue its use,
  57.     a registration fee of $5.00 is required.  Please send a check or
  58.     money order to:
  59.  
  60.     Carl Sagerquist
  61.     1414 W. Kerrick St.
  62.     Lancaster, Ca. 93534
  63.     USA
  64.  
  65.     Your support is greatly appreciated!
  66.  
  67. OPERATION
  68. ---------
  69.  
  70.     First, the caller is asked if he wants to view the newsletter:
  71.  
  72.     Display the News Letter?  (Y/n) 
  73.  
  74.     The caller has the choice to view the news letter or skip it.  Y is
  75.     default.  23 lines are displayed, then it will pause with the message: 
  76.  
  77.     Continue?  (Y/n) 
  78.  
  79.     The caller has the choice to continue or quit every 23 lines.  Y is 
  80.     default.  Communication programs such as Procomm use one line as its
  81.     own status line.  This leaves 24 lines for viewing the BBS.  The 23
  82.     lines from the news file and the line stating "Continue?  (Y/n) "
  83.     amount to 24 lines.  DISPLAY.EXE is designed to send only 24 lines at
  84.     a time, filling the remote screen.  
  85.  
  86.     If the file(s) DISPLAYQ.ASC or DISPLAYQ.ANS exist in the same
  87.     subdirectory where DISPLAY.EXE is placed, AND this is the default
  88.     directory, the contents of these files will be used for a custom
  89.     start question.  The default question...
  90.  
  91.     Display the News Letter?  (Y/n) 
  92.  
  93.     ...will be replaced with what ever you place in these files.
  94.     DISPLAYQ.ASC is the ASCII file, and DISPLAYQ.ANS is the ANSI
  95.     color file.  This file may be as large as you like, but unlike
  96.     the newsletter file, it will not pause.
  97.  
  98. OUTPUT NEWS LETTER FILE
  99. -----------------------
  100.  
  101.     This file is your choice.  You must have both ASCII (straight text)
  102.     and ANSI (color) files available, and on the command line (see the
  103.     Syntax above).  DISPLAY.EXE will choose the correct file depending
  104.     on the status of the color switch in the BBS file (DOOR.SYS,
  105.     DORINFO1.DEF, etc).  This filename may contain a path:
  106.  
  107.     DISPLAY -MAXIHOST C:\BBS\DATA\NEWSLETR.ASC C:\BBS\DATA\NEWSLETR.ANS
  108.  
  109.     You must supply the news letter files!  DISPLAY.EXE does not create
  110.     them.  DISPLAY.EXE is only a program for the display of them.
  111.  
  112.     If placed within the news letter file, the '' character (from the
  113.     <CTRL> E), will be replaced with the caller's first name.  The ''
  114.     character (from the <CTRL> F), will be replaced with the caller's
  115.     last name in the same way.  This allows you to personalize your
  116.     message file to each individual caller.  Be sure to leave room on
  117.     the line for these characters to expand to names, or the line might
  118.     get cut in half.
  119.  
  120. LIMITATIONS
  121. -----------
  122.  
  123.     1 - Each line of the news letter file must NOT exceed 256 characters,
  124.     including the carriage return.  
  125.  
  126.     2 - ASCII text must not exceed 80 characters per line INCLUDING the
  127.     CR/LF (the <ENTER>).  In other words, each line must not exceed 79
  128.     visable characters or they will spill to the next line.  This will
  129.     cause DISPLAY.EXE to send more than 23 lines at a time.
  130.  
  131.     3 - COM1 through COM4 are supported only.
  132.  
  133.     4 - If either name exceeds 15 characters, the name will be cut to 15
  134.     characters.  This should be adequate for 99.9% of all callers.
  135.  
  136.     5 - The (drive:\path\filenames) from the command line may be 65
  137.     characters long.
  138.  
  139.     6 - ASCII or ANSI files only.  The extended characters may be used,
  140.     but use caution:
  141.       - Some of them are not accepted at the remote properly.
  142.       - Files created with a word processor in Document mode will not
  143.         display correctly.
  144.       - The characters  and  (<CTRL> E and <CTRL> F) are interpreted as 
  145.         placement of the caller's first and last names.
  146.  
  147.     7 - There is no automatic word wrap.  Words may be cut in half at
  148.     the right edge of the remote (and your) screen if the lines exceed
  149.     80 characters.  The lines may be 256 characters long to accommodate
  150.     the ANSI escape characters.  Be sure that each line does not exceed
  151.     the 256 character limit.
  152.  
  153.     8 - On the lines where the caller's name will be inserted, use caution
  154.     not to allow the name to offset the remainder of the text on that
  155.     line to beyond 80 characters.  Example:
  156.  
  157. Hello,  .  How are you today?  I trust the  family is doing fine, .
  158.  
  159.     Will be transmitted looking like this:
  160.                                                                                
  161. Hello, Carl Sagerquist.  How are you today?  I trust the Sagerquist family is do
  162. ing fine, Carl.
  163.  
  164.     Obviously, not desirable appearance.  Remember to leave room for the 
  165.     names to be inserted to the line.
  166.  
  167. TECHNICAL INFORMATION
  168. ---------------------
  169.  
  170.     DISPLAY handles its own Com Port I/O.  No redirection programs are
  171.     required.  Com Ports 1 through 4 are supported. 
  172.  
  173.     Carrier loss is no problem.  DISPLAY will reset all interrupts to
  174.     their prior status before execution, and exit clean.
  175.  
  176.     The keyboard timer is set to 2 minutes.  If a caller waits a full
  177.     120 seconds without any keyboard entry, DISPLAY will exit clean.
  178.  
  179. ERRORLEVELs
  180. -----------
  181.  
  182.     On exit of DISPLAY.EXE, an errorlevel is returned to the calling batch
  183.     file.  Each errorlevel has a different meaning:
  184.  
  185.     ERRORLEVEL 35 - Unsupported COM port.
  186.     ERRORLEVEL 30 - A necessary file could not be opened.
  187.     ERRORLEVEL 20 - Carrier loss.
  188.     ERRORLEVEL 15 - Keyboard time out.
  189.     ERRORLEVEL 10 - Caller declined to read the newsletter.
  190.     ERRORLEVEL 5  - Caller partially read the newsletter.
  191.     ERRORLEVEL 0  - Caller read the newsletter completely.
  192.  
  193.     It has become my convention to return these values on exit.  This
  194.     allows the sysop some degree of control, should there be a need to
  195.     do something on exit:  If the caller does not read the newsletter,
  196.     you can enter a statement to your BBS log file by checking the
  197.     appropriate errorlevel:
  198.  
  199.     IF ERRORLEVEL 10 ECHO Declined to view Newsletter >> C:\BBS\BBS.LOG
  200.  
  201. DISCLAIMER
  202. ----------
  203.  
  204.     This program is distributed as is.  No warranty, either expressed or
  205.     implied is offered and the programmer is not responsible for any
  206.     damages or expenses that may occur through the use of this program.
  207.     The user shall determine its suitability.  Please communicate any 
  208.     difficulties with the programmer through the BBS at (805) 723-6908.
  209.  
  210.     If you like this program, drop me a message at (805) 723-6908 and
  211.     let me know.  If you have any ideas for improvement, or new ideas
  212.     you'd like to see, call and let me know.  I welcome your response.
  213.  
  214.  
  215.  
  216. Thank you for using DISPLAY.EXE!
  217.  
  218.     Carl Sagerquist
  219.     The Antelope Valley Aviator
  220.     300/1200/2400 BAUD
  221.     (805) 723-6908
  222.     A MAXIHOST BBS
  223.  
  224.  
  225. HISTORY
  226. -------
  227.  
  228. Version 1.3 - 10/10/91 - Cleaned up code a bit, errorlevels and abnormal exit
  229.              cleaned up.
  230.                - PCBoard added to supported BBS's.
  231.                - Removed "-LOCAL" switch.  Each BBS file (like
  232.              DOOR.SYS) can be set to local to allow for testing.
  233.  
  234. Version 1.2 - 10/07/91 - Added MEGAHOST as a supported BBS.
  235.  
  236. Version 1.1 - 10/05/91 - Added pause at completion of news file.
  237.                - Translation of the TAB character corrected.     
  238.  
  239. Version 1.0 - 10/01/91 - Created program.
  240.